home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / doorware / ratrce11.zip / README.TXT < prev    next >
Text File  |  1996-11-15  |  14KB  |  288 lines
  1.                       Documentation for RatRace Door Game
  2.                          Written by Robert V. Chambers
  3.                                Copyright (C) 1996
  4.  
  5.  
  6. WHAT IS RATRACE?
  7. RatRace  is a door game that lets your users  bet the odds on one of four rats
  8. that  will  race around the screen,  unpredictably  winning or losing. If your
  9. system supports EXITINFO.BBS style drop files, and will read the file when the
  10. door  exits,  this entertaining game also will  serve as a time betting game -
  11. sysop configurable.
  12.  
  13. SYSTEM REQUIREMENTS:
  14. 386 or better processor
  15. Requires ANSI graphics on the user's end
  16. 165K memory (probably less, just being conservative).
  17.  
  18. WHAT ARE SOME OF THE FEATURES?
  19. *  Optional activity log.
  20. *  Has a sysop chat mode.
  21. *  Fossil aware.
  22. *  No maintenance required.
  23. *  Automatic game reset.
  24. *  Supports   standard   drop  files   such   as  DOOR.SYS  (PCBoard/GAP),
  25.    DORINFO1.DEF, EXITINFO.BBS, CHAIN.TXT, etc.
  26. *  Supports multiple nodes.
  27.  
  28. LIMITATIONS ON UNREGISTERED VERSION:
  29. The  unregistered version will only support 5 races for each user per day. You
  30. must  register  the program to eliminate  this restriction. See the section on
  31. registration below.
  32.  
  33. UPGRADE FROM V1.0:
  34. Unzip  the archive over the existing RatRace  files in your game directory and
  35. consult SAMPLE.CFG for details on these required changes:
  36. 1) Change line 5 of RATRACE.CFG to allowed minutes per bet.
  37. 2) Add path and file name for scores bulletin to line 8 of RATRACE.CFG.
  38.  
  39. HOW DO I INSTALL IT:
  40. This is simple, but you must follow these instructions. I am assuming that you
  41. are already familiar with the steps required to install a door on your BBS. If
  42. not,  I  would  suggest  that you read  your  manual  first. This doc will not
  43. attempt to guide you through that.
  44.  
  45. Step  1)
  46.         Unzip all files into a single directory of your choice.
  47.  
  48. Step  2)
  49.         Create  a  batch file that your BBS will  use to start the door. I use
  50.         PCBoard, and my file looks something like this:
  51.  
  52.         @echo off
  53.         cd\pcb\ratrace
  54.         ratrace.exe c:\pcb\node1\door.sys /L
  55.         IF "%INPCB"=="Y" EXIT
  56.         %PCBDRIVE%
  57.         %PCBDIR%
  58.         board
  59.  
  60.         You  may call the file whatever you like, subject to restrictions that
  61.         may be enforced by your BBS software. Mine is simply called RACE, with
  62.         no .BAT extension. Again, consult your manual.
  63.  
  64.         A  little explanation of the startup batch  file is in order here. The
  65.         first  line simply changes to the  directory where all of your RatRace
  66.         Door program files are found. (Remember you put them there in Step 1.)
  67.         The second line is the name of the door program, RATRACE.EXE, followed
  68.         by  the  complete path to your drop  file  and the (optional) log file
  69.         switch.  Notice that the drop file name is specified. If you are using
  70.         PCBoard,  you  may also use the  PCBoard environment variables for the
  71.         path to the drop file. Like this:
  72.  
  73.                         ratrace.exe %PCBDRIVE%%PCBDIR%\door.sys
  74.  
  75.         If you wish the program to log its activities, add "/L" after the path
  76.         to  the  drop  file like this:
  77.  
  78.                         ratrace.exe %PCBDRIVE%%PCBDIR%\door.sys /L
  79.  
  80.         The program will create RATRACE.LOG which will contain information on
  81.         door usage.  See the section below on "LOGGING ACTIVITY".
  82.  
  83.         Finally,   use   whatever  door   exiting   statements  your  software
  84.         recommends. Your startup file will undoubtedly look different, but you
  85.         get the general idea.
  86.  
  87.  
  88. Step  3)
  89.         Setup  your BBS software and configure  any door menus, etc. that give
  90.         the user access.
  91.  
  92.  
  93. Step  4)
  94.         Edit  the sample configuration file to suit your tastes and save it as
  95.         RATRACE.CFG.  Instructions  for each line  are contained in the sample
  96.         file, SAMPLE.CFG.
  97.  
  98. Step  5)
  99.         You're finished! That wasn't so bad after all.
  100.  
  101. PS-> Don't forget to advertise that you now have a new door on your system!
  102.  
  103. RUNNING LOCAL:
  104. You can run the game in local mode if a drop file is in the program directory.
  105. DORINFO1.DEF is included in the archive for this purpose. Just place it in the
  106. door  program  file directory and execute  the program by running RATRACE.EXE.
  107. You  should be able to leave this file  in your game directory with no problem
  108. since  you  have defined the path to the  real drop file in your startup batch
  109. file.  Note  that the user name in the  sample  drop file will be added in the
  110. scores  bulletin.  Therefore you should only  run locally to initially try out
  111. the game, resetting after you have finished (See Resetting the Game).
  112.  
  113. CUSTOMIZATION:
  114.  
  115. - BETTING TIME
  116. If  your system supports EXITINFO.BBS style drop files, and will read the file
  117. when  the  door exits, you can set up  the  program to enable the time betting
  118. function.  Change line 3 to YES. When playing  in this mode all odds are even,
  119. so  the user is not likely to come  out ahead over time. This is documented in
  120. the  online  help, so there should not  be  any surprises here. Also, the user
  121. cannot cheat while wagering time.
  122.  
  123. -  RAT NAMES
  124. If  you  want to include some of your  favorite  "rats" in the races just edit
  125. RATNAMES.TXT  with  any  text editor. You can add  up  to 20 names of up to 30
  126. characters each. You don't have to add all 20 -- the default names in the game
  127. will  finish out the array. A sample file  is included; by all means modify it
  128. to  suit  your preferences. (Just for grins you  ought to add your OWN name in
  129. here, and maybe a couple of your "favorite" users <G>.)
  130.  
  131. -  TITLE  SCREEN  If you want a new title  screen  you can do it. Create a new
  132. screen  using  your favorite ANSI editor,  and call it TITLE.ANS. Leave enough
  133. room  at the bottom for the additional registration text. It's *CRITICAL* that
  134. you name this file correctly.
  135.  
  136. - INACTIVITY TIMEOUT AND MAXIMUM DOOR TIME
  137. You  may specify the maximum time allowed in the door and the keyboard timeout
  138. limit  by  editing DOOR.CFG. Instructions are in  this file and should be self
  139. explanatory.
  140.  
  141. LOGGING ACTIVITY:
  142. The program will provide logging of activity if the logging switch is included
  143. in the startup command line in your batch file. For example:
  144.  
  145.                      ratrace.exe c:\pcb\node1\door.sys /L
  146.  
  147. will  cause the program to record entry, exit, and maintenance times in a file
  148. called  RATRACE.LOG.  This  file  can  become  lengthy  if  the  door  is used
  149. regularly.  A  suggestion  is  to enable  logging  when  the door is initially
  150. installed  to monitor its use. After a period  of time you may wish to disable
  151. logging or trim the file occasionally (there are programs that will do this in
  152. an event). Please note that the switch (/L) is case specific and there must be
  153. a space between it and the path to the drop file.
  154.  
  155. MAINTENANCE:
  156. There  is no maintenance! The game will run its own maintenance when the first
  157. player  of the day enters the game. A scores bulletin is automatically created
  158. when  the scores are viewed and again when  the game exits. Both ansi and text
  159. versions (.ANS and .TXT extensions) are created.
  160.  
  161. MULTINODE USE:
  162. The  game is set up to run on  multiple nodes with multiple player access. You
  163. should  follow your BBS software instructions  on setting up the startup batch
  164. file for multiple nodes.
  165.  
  166. RESETTING THE GAME:
  167. You should never need to reset the game, but if you want to this has been made
  168. simple  with  the inclusion of RESET.BAT in  the archive. This batch file will
  169. delete all files generated by the game (except bulletins).
  170.  
  171. Or  you  can perform the task manually if  there are certain files you want to
  172. preserve,  like  the log file. Just delete  all  the .DAT files in the RatRace
  173. directory.  Resetting  the game should never  be necessary since the game will
  174. automatically reset the scores, etc. when there is a winner. If a player is on
  175. one  node when the game is won on another  node he will be able to continue to
  176. play, but will be reset when exiting the door.
  177.  
  178. TROUBLE  SHOOTING:
  179. The  program  has been successfully tested  with PCBoard running under DOS and
  180. Windows  95,  as  well  as  Dos  with  Desqview.  Both  single  and multi-node
  181. configurations have also been tested.
  182.  
  183. Testing is incomplete on the time betting feature due to lack of a test system
  184. that  would  read the drop file on door  exit. I'd appreciate an e-mail if you
  185. have used this feature and have some comments or suggestions.
  186.  
  187. In  the  event you have trouble maybe some  of  these tips will help you. This
  188. list  is  not  very  long yet, but  will  be  added  to as information becomes
  189. available.
  190.  
  191. 1)  The  door  will not open at all.  It  looks like it tries, but immediately
  192. shuts down and returns to the BBS.
  193.  
  194. -  This is almost certainly a sign that the startup file is not specifying the
  195. correct  path  and/or file name of the  drop file. It's also possible that you
  196. have  not  set the board up correctly and  the expected drop file is not being
  197. created.  The  startup batch file must include  the full path and file name of
  198. the  drop  file as an argument to  the executable, RATRACE.EXE. See the sample
  199. startup file above.
  200.  
  201. 2)  You  are using DOOR.SYS and the  door  keeps logging you out when entering
  202. locally.
  203.  
  204. - If you are not using the long GAP version (51 lines) of DOOR.SYS then either
  205. go  to  the long version or try  DORINFO1.DEF. The DORINFO style drop file has
  206. been successfully tested on Maximus with some of my other door programs.
  207.  
  208. 3)  The graphics don't behave exactly right (on the user's end) with the board
  209. running under Windows 95.
  210.  
  211. -  If  you  experience problems with this  try  running the window either full
  212. screen  or  in  the  foreground. This seems  to  solve  the problem if you are
  213. running  the  X00 fossil driver, but is  not feasible if running more than one
  214. node. Try switching to the BNU fossil driver. This driver seems to work better
  215. with  Win95,  and  cleared up the graphics  problem  for  me (I was previously
  216. running X00).
  217.  
  218. THE LEGAL STUFF:
  219. Users  of RatRace Door must accept  this disclaimer of warranty: "RatRace Door
  220. is  supplied as is. The author disclaims all warranties, expressed or implied,
  221. including,  without  limitation,  the  warranties  of  merchantability  and of
  222. fitness  for any purpose. The author  assumes no liability for damages, direct
  223. or consequential, which may result from the use of RatRace."
  224.  
  225. By  registering  you do NOT own this  software.  You have simply licensed it's
  226. use.  You may use it on as many BBS  nodes as you wish, as long as these nodes
  227. comprise  a single bulletin board system. You  may create as many instances of
  228. the program as you wish, as long as they all reside on a single bulletin board
  229. system.
  230.  
  231. You  are  encouraged to pass a copy of  RatRace Door along to your friends for
  232. evaluation.  Please  encourage them to register  their  copy if they find that
  233. they  can use it. You may NOT pass along your registration code, however. This
  234. should go without saying.
  235.  
  236. REGISTRATION :
  237. This  is  not  freeware; it is shareware.  If  you  are not familiar with this
  238. concept it means that you are allowed to try the software free of charge for a
  239. period  of time not to exceed 30 days. At the end of this time you must either
  240. register it or remove it from your system.
  241.  
  242. I  feel  that  the  time  invested in  writing  and  testing  the  program was
  243. significant  enough  to justify a registration fee.  The cost is $10 U.S., and
  244. payment  may be made via check drawn on  a United States bank. No credit cards
  245. are accepted. I will take your cash, but you send it at your own risk.
  246.  
  247. To  register  fill  out REGISTER.FRM (included)  and  send it, along with your
  248. check  or money order, to the address on  the form. I will respond to you with
  249. your  registration  either  through U.S.  Postal  Service, Fidonet Netmail, or
  250. Internet E-Mail. The choice is yours; just be sure to specify which you prefer
  251. on the form.
  252.  
  253. When  you receive your registration code  manually edit RATRACE.CFG and change
  254. the first two lines to your registered name and code number. Your name is case
  255. and space sensitive; it must be EXACTLY right. Watch out for spaces at the end
  256. of your name.
  257.  
  258. The  unregistered  version  will  only  support  5  races  per  day  per user.
  259. Registration  will  remove this limitation  and  allow nearly unlimited races.
  260. Registration will also entitle you to free lifetime upgrades.
  261.  
  262. There  will  be no automatic notification of  upgrades. You can always get the
  263. latest  version  from my BBS, Tequilla  Sunrise,  at (504)-756-0383. Just type
  264. FREE  at  the  main  menu prompt. There  is  no  charge  (except LD charges if
  265. applicable) for the file or to become a member of the BBS.
  266.  
  267.  
  268. TECHNICAL SUPPORT:
  269. Technical support will be provided to both registered and non-registered users
  270. to  the  best  of my ability.
  271.  
  272. You may reach me via the following:
  273.  
  274. Fidonet -              Robert Chambers@1:3800/49
  275. Internet EMail -       chambers@premier.net
  276. Tequilla Sunrise BBS - (504)-756-0383
  277.  
  278.  
  279. MANY THANKS!:
  280. I  would  like  to thank Fred Leger,  Dennis  Wallette, and Henry Lin of Cajun
  281. Clickers  BBS  from Baton Rouge, Louisiana,  for helping with beta testing and
  282. bug  fixing  as  well as thoughts  and  suggestions for improving the program.
  283. These  folks are the real heroes here, and they run one of the slickest boards
  284. around.
  285.  
  286. Thanks to all you guys!  I owe you one!
  287.  
  288.